/*
 * Copyright ©2015-2021 Jaemon. All Rights Reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package io.gitee.jaemon.spring.adorner.core;

import io.gitee.jaemon.spring.adorner.exception.AdornerException;
import io.gitee.jaemon.spring.adorner.type.ApiDefinition;

import java.util.List;

/**
 * 文档生成器
 *
 * @author Jaemon
 * @since 1.0
 */
public interface DocGenerator<T> {

    /**
     * 生成文档
     *
     * @param apiDefinitions
     *      接口定义集合 {@link ApiDefinition}
     * @param context
     *      上下文对象
     * @throws AdornerException
     *      ex {@link AdornerException}
     */
    void generate(List<ApiDefinition<T>> apiDefinitions, AdornerApplicationContext context) throws AdornerException;

}